WebDavResource.java

/*
  Copyright 2011-2014 Red Hat, Inc

  This file is part of PressGang CCMS.

  PressGang CCMS is free software: you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  PressGang CCMS is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with PressGang CCMS.  If not, see <http://www.gnu.org/licenses/>.
*/

package org.jboss.pressgang.ccms.server.webdav.jaxrs;

import static net.java.dev.webdav.jaxrs.Headers.DAV;
import static net.java.dev.webdav.jaxrs.Headers.DEPTH;
import static net.java.dev.webdav.jaxrs.Headers.DESTINATION;
import static net.java.dev.webdav.jaxrs.Headers.OVERWRITE;

import javax.enterprise.context.RequestScoped;
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.OPTIONS;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.ext.Providers;
import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;

import net.java.dev.webdav.jaxrs.methods.COPY;
import net.java.dev.webdav.jaxrs.methods.MKCOL;
import net.java.dev.webdav.jaxrs.methods.MOVE;
import net.java.dev.webdav.jaxrs.methods.PROPFIND;
import net.java.dev.webdav.jaxrs.methods.PROPPATCH;
import org.jboss.pressgang.ccms.server.webdav.constants.WebDavConstants;
import org.jboss.pressgang.ccms.server.webdav.managers.CompatibilityManager;
import org.jboss.pressgang.ccms.server.webdav.resources.ByteArrayReturnValue;
import org.jboss.pressgang.ccms.server.webdav.resources.InternalResource;
import org.jboss.pressgang.ccms.server.webdav.utils.WebDavUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This JAX-RS endpoint captures all requests. It then relays them to the InternalResource class,
 * which will build the objects that will actually respond to the requests.
 */
@RequestScoped
@Path("/webdav{var:.*}")
public class WebDavResource {
    public static final String WEBDAV_COMPLIANCE_LEVEL = "1";

    private static final Logger LOGGER = LoggerFactory.getLogger(WebDavResource.class.getName());

    @Inject
    protected CompatibilityManager compatibilityManager;

    @GET
    @Produces(MediaType.APPLICATION_OCTET_STREAM)
    public javax.ws.rs.core.Response get(@Context final UriInfo uriInfo, @Context final HttpServletRequest req,
            @HeaderParam(WebDavConstants.X_FORWARD_FOR_HEADER) final String xForwardForHeader) {
        final ByteArrayReturnValue stringValueReturn = InternalResource.get(compatibilityManager,
                WebDavUtils.getRemoteAddress(req, xForwardForHeader), uriInfo);
        if (stringValueReturn.getStatusCode() != javax.ws.rs.core.Response.Status.OK.getStatusCode()) {
            return javax.ws.rs.core.Response.status(stringValueReturn.getStatusCode()).build();
        }

        return javax.ws.rs.core.Response.ok().entity(stringValueReturn.getValue()).build();
    }

    @PUT
    @Consumes(MediaType.MEDIA_TYPE_WILDCARD)
    public javax.ws.rs.core.Response put(@Context final UriInfo uriInfo, @Context final HttpServletRequest req,
            @HeaderParam(WebDavConstants.X_FORWARD_FOR_HEADER) final String xForwardForHeader,
            final InputStream entityStream) throws IOException, URISyntaxException {
        return InternalResource.put(compatibilityManager, WebDavUtils.getRemoteAddress(req, xForwardForHeader), uriInfo, entityStream);
    }

    @MKCOL
    public javax.ws.rs.core.Response mkcol() {
        LOGGER.debug("ENTER WebDavResource.mkcol()");
        return javax.ws.rs.core.Response.serverError().build();
    }

    @Produces(MediaType.APPLICATION_XML)
    @PROPFIND
    public javax.ws.rs.core.Response propfind(@Context final UriInfo uriInfo, @Context final HttpServletRequest req,
            @HeaderParam(WebDavConstants.X_FORWARD_FOR_HEADER) final String xForwardForHeader,
            @HeaderParam(DEPTH) final String depth) throws URISyntaxException, IOException {
        LOGGER.debug("ENTER WebDavResource.propfind()");
        return InternalResource.propfind(compatibilityManager, WebDavUtils.getRemoteAddress(req, xForwardForHeader), uriInfo, depth);
    }

    @PROPPATCH
    public javax.ws.rs.core.Response proppatch(@Context final UriInfo uriInfo, @Context final HttpServletRequest req,
            final InputStream body, @Context final Providers providers,
            @Context final HttpHeaders httpHeaders) throws IOException, URISyntaxException {
        LOGGER.debug("ENTER WebDavResource.proppatch()");
        return javax.ws.rs.core.Response.serverError().build();
    }

    @COPY
    public javax.ws.rs.core.Response copy(@Context final UriInfo uriInfo, @Context final HttpServletRequest req,
            @HeaderParam(WebDavConstants.X_FORWARD_FOR_HEADER) final String xForwardForHeader,
            @HeaderParam(OVERWRITE) final String overwriteStr, @HeaderParam(DESTINATION) final String destination) {
        return InternalResource.copy(compatibilityManager, WebDavUtils.getRemoteAddress(req, xForwardForHeader), uriInfo, overwriteStr,
                destination);
    }

    /*
        201 (Created)	The resource was moved successfully and a new resource was created at the specified destination URI.
        204 (No Content)	The resource was moved successfully to a pre-existing destination URI.
        403 (Forbidden)	The source URI and the destination URI are the same.
        409 (Conflict)	A resource cannot be created at the destination URI until one or more intermediate collections are created.
        412 (Precondition Failed)	Either the Overwrite header is "F" and the state of the destination resource is not null,
        or the method was used in a Depth: 0 transaction.
        423 (Locked)	The destination resource is locked.
        502 (Bad Gateway)	The destination URI is located on a different server, which refuses to accept the resource.
     */
    @MOVE
    public javax.ws.rs.core.Response move(@Context final UriInfo uriInfo, @Context final HttpServletRequest req,
            @HeaderParam(WebDavConstants.X_FORWARD_FOR_HEADER) final String xForwardForHeader,
            @HeaderParam(OVERWRITE) final String overwriteStr,
            @HeaderParam(DESTINATION) final String destination) throws URISyntaxException {
        return InternalResource.move(compatibilityManager, WebDavUtils.getRemoteAddress(req, xForwardForHeader), uriInfo, overwriteStr,
                destination);
    }

    @DELETE
    public javax.ws.rs.core.Response delete(@Context final UriInfo uriInfo,
            @HeaderParam(WebDavConstants.X_FORWARD_FOR_HEADER) final String xForwardForHeader, @Context final HttpServletRequest req) {
        return InternalResource.delete(compatibilityManager, WebDavUtils.getRemoteAddress(req, xForwardForHeader), uriInfo);
    }

    @OPTIONS
    public javax.ws.rs.core.Response options() {
        LOGGER.debug("ENTER WebDavResource.options()");
        javax.ws.rs.core.Response.ResponseBuilder builder = javax.ws.rs.core.Response.ok();
        builder.header(DAV, WEBDAV_COMPLIANCE_LEVEL);

        return builder.build();
    }
}